DescribeDisks

Description

call the DescribeDisks to query one or more blocks of block storage (including cloud disks and local disks) that you have created.

Request Method

POST

Request Path

/apsara/route/Ecs/DescribeDisks

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
AdditionalAttributes.N	BODY	repeatlist	No	null	other attribute values. Description This parameter is about to be stopped. In order to improve code compatibility, it is recommended that you try not to use this parameter.
Category	BODY	string	No	all	cloud disk or local disk type. Value range: all: all cloud disks and local disks cloud: ordinary cloud disk cloud_efficiency: efficient cloud disk cloud_ssd:SSD cloud_essd:ESSD cloud disk local_ssd_pro:I/O intensive local disk local_hdd_pro: throughput-intensive local disk ephemeral:(discontinued) local disk ephemeral_ssd:(discontinued) local SSD disk default value: all.
Filter. 1.Key	BODY	string	No	CreationStartTime	filter key when querying resources. The value must be CreationStartTime.
KMSKeyId	BODY	string	No	0e478b7a-4262-4802-b8cb-00d3fb408***	KMS key ID used by the cloud disk.
PageSize	BODY	integer	No	10	the number of rows per page set during paging query. maximum value: 100. default value: 10.
NextToken	BODY	string	No	AAAAAdDWBF2****	query credentials (Token), the value is NextToken parameter value returned from the last API call.
ResourceGroupId	BODY	string	No	rg-bp67acfmxazb4p****	the ID of the enterprise resource group where the cloud disk or local disk is located.
Encrypted	BODY	boolean	No	false	whether only encrypted cloud disks are filtered out. default value: false.
DeleteAutoSnapshot	BODY	boolean	No	false	whether the automatic snapshot will be released at the same time when the cloud disk is released. default value: false.
DryRun	BODY	boolean	No	false	whether to precheck only this request. Value range: true: sends a check request and does not query the resource status. Check items include whether the AccessKey is valid, the authorization status of RAM users, and whether required parameters are filled in. If the check fails, the corresponding error is returned. If the check passes, error code DryRunOperation will be returned. false: sends a normal request, returns a 2XX HTTP status code after checking, and directly queries the resource status. default value: false.
DiskType	BODY	string	No	all	the cloud disk or local disk type to query. Value range: all: query system disk and data disk at the same time system: query system disk only data: query only data disk default value: all.
PageNumber	BODY	integer	No	1	page number of cloud disk or local disk status list. starting value: 1. default value: 1.
Tag.N.Value	BODY	string	No	TestValue	the label value of the cloud disk or the local disk. The value range of n is 1~20.
Filter. 1.Value	BODY	string	No	2017-12-05T22:40:00Z	filter value when querying resources. The value must be the start time point of resource creation (CreationStartTime).
Status	BODY	string	No	All	cloud disk status. Value range: In_use Available Attaching Detaching Creating ReIniting All default value: All.
DiskIds	BODY	string	No	["d-bp67acfmxazb4p****", "d-bp67acfmxazb4p ****",… "d-bp67acfmxazb4p****"]	cloud disk or local disk ID. A formatted JSON array with up to 100 IDs separated by commas (,).
EnableShared	BODY	boolean	No	false	whether it is shared block storage.
Tag.N.Key	BODY	string	No	TestKey	the tag key of the cloud disk or the local disk. The value range of n is 1~20.
ZoneId	BODY	string	No	cn-qingdao-env17-amtest11001-a	zone ID.
InstanceId	BODY	string	No	i-bp67acfmxazb4p****	the instance ID mounted on the cloud disk or local disk.
DeleteWithInstance	BODY	boolean	No	false	whether the cloud disk is set to be released with the instance. Value range: true: the cloud disk is released with the instance. false: the cloud disk is retained and not released. default value: false.
MaxResults	BODY	integer	No	50	The maximum number returned. Value range: 1~500 default value: 10.
EnableAutomatedSnapshotPolicy	BODY	boolean	No	false	whether to query the cloud disk with automatic snapshot policy enabled. default value: false.
AutoSnapshotPolicyId	BODY	string	No	sp-m5e2w2jutw8bv31a****	query the cloud disk according to the automatic snapshot policy ID.
DiskName	BODY	string	No	test-DiskName	cloud disk or local disk name.
version	BODY	string	No	2016-01-01	version of api
Filter. 2.Key	BODY	string	No	CreationEndTime	filter key when querying resources. The value must be CreationEndTime.
SnapshotId	BODY	string	No	s-bp67acfmxazb4p****	the snapshot ID used to create the cloud disk.
Portable	BODY	boolean	No	false	whether cloud disks or local disks support uninstallation. Value range: true: supported. It can exist independently and can be mounted and unloaded freely in the zone. false: not supported. It cannot exist independently and cannot be mounted and unloaded freely in the zone. /ul> p data-tag = "p" class = "p"> if you need to do attach and detach operations, you must first query this attribute before you can operate on a disk that is true. The system disk of the common cloud disk, the efficient cloud disk, and the SSD cloud disk. This attribute is false. This attribute cannot be changed by the user.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Filter. 2.Value	BODY	string	No	2017-12-06T22:40:00Z	filter value when querying resources. The value must be the end time of resource creation (CreationEndTime).
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	the region ID to which the block store belongs. You can call the DescribeRegions to view the latest Alibaba Cloud region list.

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}